package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendanceDedParamAddDTO;
import org.jsola.hr.dto.AttendanceDedParamUpdateDTO;
import org.jsola.hr.query.AttendanceDedParamQuery;
import org.jsola.hr.vo.AttendanceDedParamListVO;
import org.jsola.hr.vo.AttendanceDedParamVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-考勤扣款设置参数")
public interface IAttendanceDedParamControllerAPI {

    /**
     * 新增考勤扣款设置参数
     * @param attendanceDedParamAddDTO 考勤扣款设置参数新增实体
     * @return 考勤扣款设置参数展示对象
     */
    @ApiOperation(value = "新增考勤扣款设置参数")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedParamAddDTO", dataType = "AttendanceDedParamAddDTO", value = "新增考勤扣款设置参数", paramType = "body")
    })
    Result<AttendanceDedParamVO> save(AttendanceDedParamAddDTO attendanceDedParamAddDTO);


    /**
     * 修改考勤扣款设置参数
     * @param attendanceDedParamUpdateDTO 考勤扣款设置参数
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤扣款设置参数")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedParamUpdateDTO", dataType = "AttendanceDedParamUpdateDTO", value = "修改考勤扣款设置参数", paramType = "body")
    })
    Result<Integer> update(AttendanceDedParamUpdateDTO attendanceDedParamUpdateDTO);




    /**
     * 删除单个考勤扣款设置参数，彻底删除
     * @param attendanceDedParamId 考勤扣款设置参数id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤扣款设置参数，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedParamId", dataType = "String", value = "考勤扣款设置参数id", paramType = "path")
    })
    Result<Integer> delete(String attendanceDedParamId);


    /**
     * 批量删除考勤扣款设置参数，彻底删除
     * @param attendanceDedParamIds 考勤扣款设置参数id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤扣款设置参数，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedParamIds", dataType = "String[]", value = "考勤扣款设置参数id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendanceDedParamIds);


    /**
     * 根据考勤扣款设置参数id查询考勤扣款设置参数详情
     * @param attendanceDedParamId 考勤扣款设置参数id
     * @return 考勤扣款设置参数详情
     */
    @ApiOperation(value="根据考勤扣款设置参数id查询考勤扣款设置参数详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedParamId", dataType = "String", value = "考勤扣款设置参数id", paramType = "path")
    })
    Result<AttendanceDedParamVO> findById(String attendanceDedParamId);


    /**
     * 查询考勤扣款设置参数
     * @param attendanceDedParamQuery 考勤扣款设置参数查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤扣款设置参数")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedParamQuery", dataType = "AttendanceDedParamQuery", value = "考勤扣款设置参数查询参数", paramType = "query")
    })
    Result<List<AttendanceDedParamListVO>> listAll(AttendanceDedParamQuery attendanceDedParamQuery);


     /**
     * 分页查询考勤扣款设置参数
     * @param attendanceDedParamQuery 考勤扣款设置参数查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤扣款设置参数")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedParamQuery", dataType = "AttendanceDedParamQuery", value = "考勤扣款设置参数查询参数", paramType = "query")
    })
    Result<Page<AttendanceDedParamListVO>> page(AttendanceDedParamQuery attendanceDedParamQuery);


}

